/* 
 * Shuriken is the legal property of its developers. Please refer to the
 * COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms; 
using Shuriken.Core.Ranking;
using Shuriken.Core.Store; 
using Shuriken.Core.UI;

namespace Shuriken.Core.UI
{
    public enum ShowHideReason
    {
        EnterKey,
        Hotkey,
        NotifyIcon
    }
    

    /// <summary>
    /// All the method needed for creating a new UI
    /// </summary>
    internal interface IUIProvider
    {
        /// <summary>
        /// Registers the manager with the form 's key events 
        /// </summary>
        /// <param name="Manager">UI Manager</param>
        void RegisterUIManager(UIManager Manager);

        /// <summary>
        /// Show or hides the UI. 
        /// </summary>
        /// <remarks>
        /// This method is called when the hotkey is pressed. 
        /// </remarks>
        void ShowHideAction(ShowHideReason reason);

        /// <summary>
        /// Tells if the UI visible or not
        /// </summary>
        /// <returns>true, if the ui is visible, false otherwise</returns>
        bool IsUIVisible();


        /// <summary>
        /// UIManager sends an escape action to the UI
        /// </summary>
        /// <remarks>
        /// </remarks>
        void EscapeAction();

        /// <summary>
        /// Tab key was pressed
        /// </summary>
        /// <remarks>
        /// </remarks>
        void TabAction();

        /// <summary>
        /// Activates the given ui slot. 
        /// </summary>
        /// <param name="slotIndex">slot to activate</param>
        void ActivateUISlot(int slotIndex); 

        /// <summary>
        /// Gets the current UI slot. 
        /// </summary>
        /// <returns>currently slot</returns>
        List<IUIDisplaySlot> GetListOfUISlots();

        /// <summary>
        /// The current display slot 
        /// </summary>
        /// <returns></returns>
        IUIDisplaySlot CurrentDisplaySlot
        {
            get; 
        }

        /// <summary>
        /// Enabling or disabling text entry mode. 
        /// </summary>
        void TextEntryMode(bool enabled);

        bool IsTextEntryActive
        {
            get; 
        }
    }
}
